

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Excel &mdash; O365  documentation</title>
      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />

  
      <script src="../_static/jquery.js?v=5d32c60e"></script>
      <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
      <script src="../_static/documentation_options.js?v=5929fcd5"></script>
      <script src="../_static/doctools.js?v=9bcbadda"></script>
      <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Group" href="group.html" />
    <link rel="prev" title="Directory" href="directory.html" />
    <link href="../_static/css/style.css" rel="stylesheet" type="text/css">

</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="../index.html">
            
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage.html">Detailed Usage</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">O365 API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="account.html">Account</a></li>
<li class="toctree-l2"><a class="reference internal" href="address_book.html">Address Book</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendar</a></li>
<li class="toctree-l2"><a class="reference internal" href="category.html">Category</a></li>
<li class="toctree-l2"><a class="reference internal" href="connection.html">Connection</a></li>
<li class="toctree-l2"><a class="reference internal" href="directory.html">Directory</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Excel</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#O365.excel.FunctionException"><code class="docutils literal notranslate"><span class="pre">FunctionException</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#O365.excel.NamedRange"><code class="docutils literal notranslate"><span class="pre">NamedRange</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.NamedRange.__init__"><code class="docutils literal notranslate"><span class="pre">NamedRange.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.NamedRange.comment"><code class="docutils literal notranslate"><span class="pre">NamedRange.comment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.NamedRange.data_type"><code class="docutils literal notranslate"><span class="pre">NamedRange.data_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.NamedRange.get_range"><code class="docutils literal notranslate"><span class="pre">NamedRange.get_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.NamedRange.name"><code class="docutils literal notranslate"><span class="pre">NamedRange.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.NamedRange.object_id"><code class="docutils literal notranslate"><span class="pre">NamedRange.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.NamedRange.scope"><code class="docutils literal notranslate"><span class="pre">NamedRange.scope</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.NamedRange.update"><code class="docutils literal notranslate"><span class="pre">NamedRange.update()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.NamedRange.value"><code class="docutils literal notranslate"><span class="pre">NamedRange.value</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.NamedRange.visible"><code class="docutils literal notranslate"><span class="pre">NamedRange.visible</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.excel.Range"><code class="docutils literal notranslate"><span class="pre">Range</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.__init__"><code class="docutils literal notranslate"><span class="pre">Range.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.address"><code class="docutils literal notranslate"><span class="pre">Range.address</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.address_local"><code class="docutils literal notranslate"><span class="pre">Range.address_local</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.cell_count"><code class="docutils literal notranslate"><span class="pre">Range.cell_count</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.clear"><code class="docutils literal notranslate"><span class="pre">Range.clear()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.column_count"><code class="docutils literal notranslate"><span class="pre">Range.column_count</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.column_hidden"><code class="docutils literal notranslate"><span class="pre">Range.column_hidden</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.column_index"><code class="docutils literal notranslate"><span class="pre">Range.column_index</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.delete"><code class="docutils literal notranslate"><span class="pre">Range.delete()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.formulas"><code class="docutils literal notranslate"><span class="pre">Range.formulas</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.formulas_local"><code class="docutils literal notranslate"><span class="pre">Range.formulas_local</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.formulas_r1_c1"><code class="docutils literal notranslate"><span class="pre">Range.formulas_r1_c1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_bounding_rect"><code class="docutils literal notranslate"><span class="pre">Range.get_bounding_rect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_cell"><code class="docutils literal notranslate"><span class="pre">Range.get_cell()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_column"><code class="docutils literal notranslate"><span class="pre">Range.get_column()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_columns_after"><code class="docutils literal notranslate"><span class="pre">Range.get_columns_after()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_columns_before"><code class="docutils literal notranslate"><span class="pre">Range.get_columns_before()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_entire_column"><code class="docutils literal notranslate"><span class="pre">Range.get_entire_column()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_format"><code class="docutils literal notranslate"><span class="pre">Range.get_format()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_intersection"><code class="docutils literal notranslate"><span class="pre">Range.get_intersection()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_last_cell"><code class="docutils literal notranslate"><span class="pre">Range.get_last_cell()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_last_column"><code class="docutils literal notranslate"><span class="pre">Range.get_last_column()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_last_row"><code class="docutils literal notranslate"><span class="pre">Range.get_last_row()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_offset_range"><code class="docutils literal notranslate"><span class="pre">Range.get_offset_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_resized_range"><code class="docutils literal notranslate"><span class="pre">Range.get_resized_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_row"><code class="docutils literal notranslate"><span class="pre">Range.get_row()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_rows_above"><code class="docutils literal notranslate"><span class="pre">Range.get_rows_above()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_rows_below"><code class="docutils literal notranslate"><span class="pre">Range.get_rows_below()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_used_range"><code class="docutils literal notranslate"><span class="pre">Range.get_used_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.get_worksheet"><code class="docutils literal notranslate"><span class="pre">Range.get_worksheet()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.hidden"><code class="docutils literal notranslate"><span class="pre">Range.hidden</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.insert_range"><code class="docutils literal notranslate"><span class="pre">Range.insert_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.merge"><code class="docutils literal notranslate"><span class="pre">Range.merge()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.number_format"><code class="docutils literal notranslate"><span class="pre">Range.number_format</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.object_id"><code class="docutils literal notranslate"><span class="pre">Range.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.row_count"><code class="docutils literal notranslate"><span class="pre">Range.row_count</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.row_hidden"><code class="docutils literal notranslate"><span class="pre">Range.row_hidden</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.row_index"><code class="docutils literal notranslate"><span class="pre">Range.row_index</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.text"><code class="docutils literal notranslate"><span class="pre">Range.text</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.to_api_data"><code class="docutils literal notranslate"><span class="pre">Range.to_api_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.unmerge"><code class="docutils literal notranslate"><span class="pre">Range.unmerge()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.update"><code class="docutils literal notranslate"><span class="pre">Range.update()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.value_types"><code class="docutils literal notranslate"><span class="pre">Range.value_types</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Range.values"><code class="docutils literal notranslate"><span class="pre">Range.values</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.excel.RangeFormat"><code class="docutils literal notranslate"><span class="pre">RangeFormat</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.__init__"><code class="docutils literal notranslate"><span class="pre">RangeFormat.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.auto_fit_columns"><code class="docutils literal notranslate"><span class="pre">RangeFormat.auto_fit_columns()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.auto_fit_rows"><code class="docutils literal notranslate"><span class="pre">RangeFormat.auto_fit_rows()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.background_color"><code class="docutils literal notranslate"><span class="pre">RangeFormat.background_color</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.column_width"><code class="docutils literal notranslate"><span class="pre">RangeFormat.column_width</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.font"><code class="docutils literal notranslate"><span class="pre">RangeFormat.font</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.horizontal_alignment"><code class="docutils literal notranslate"><span class="pre">RangeFormat.horizontal_alignment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.range"><code class="docutils literal notranslate"><span class="pre">RangeFormat.range</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.row_height"><code class="docutils literal notranslate"><span class="pre">RangeFormat.row_height</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.session"><code class="docutils literal notranslate"><span class="pre">RangeFormat.session</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.set_borders"><code class="docutils literal notranslate"><span class="pre">RangeFormat.set_borders()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.to_api_data"><code class="docutils literal notranslate"><span class="pre">RangeFormat.to_api_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.update"><code class="docutils literal notranslate"><span class="pre">RangeFormat.update()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.vertical_alignment"><code class="docutils literal notranslate"><span class="pre">RangeFormat.vertical_alignment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormat.wrap_text"><code class="docutils literal notranslate"><span class="pre">RangeFormat.wrap_text</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.excel.RangeFormatFont"><code class="docutils literal notranslate"><span class="pre">RangeFormatFont</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormatFont.__init__"><code class="docutils literal notranslate"><span class="pre">RangeFormatFont.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormatFont.bold"><code class="docutils literal notranslate"><span class="pre">RangeFormatFont.bold</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormatFont.color"><code class="docutils literal notranslate"><span class="pre">RangeFormatFont.color</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormatFont.italic"><code class="docutils literal notranslate"><span class="pre">RangeFormatFont.italic</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormatFont.name"><code class="docutils literal notranslate"><span class="pre">RangeFormatFont.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormatFont.parent"><code class="docutils literal notranslate"><span class="pre">RangeFormatFont.parent</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormatFont.size"><code class="docutils literal notranslate"><span class="pre">RangeFormatFont.size</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormatFont.to_api_data"><code class="docutils literal notranslate"><span class="pre">RangeFormatFont.to_api_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.RangeFormatFont.underline"><code class="docutils literal notranslate"><span class="pre">RangeFormatFont.underline</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.excel.Table"><code class="docutils literal notranslate"><span class="pre">Table</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.__init__"><code class="docutils literal notranslate"><span class="pre">Table.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.add_column"><code class="docutils literal notranslate"><span class="pre">Table.add_column()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.add_rows"><code class="docutils literal notranslate"><span class="pre">Table.add_rows()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.clear_filters"><code class="docutils literal notranslate"><span class="pre">Table.clear_filters()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.convert_to_range"><code class="docutils literal notranslate"><span class="pre">Table.convert_to_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.delete"><code class="docutils literal notranslate"><span class="pre">Table.delete()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.delete_column"><code class="docutils literal notranslate"><span class="pre">Table.delete_column()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.delete_row"><code class="docutils literal notranslate"><span class="pre">Table.delete_row()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.get_column"><code class="docutils literal notranslate"><span class="pre">Table.get_column()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.get_column_at_index"><code class="docutils literal notranslate"><span class="pre">Table.get_column_at_index()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.get_columns"><code class="docutils literal notranslate"><span class="pre">Table.get_columns()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.get_data_body_range"><code class="docutils literal notranslate"><span class="pre">Table.get_data_body_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.get_header_row_range"><code class="docutils literal notranslate"><span class="pre">Table.get_header_row_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.get_range"><code class="docutils literal notranslate"><span class="pre">Table.get_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.get_row"><code class="docutils literal notranslate"><span class="pre">Table.get_row()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.get_row_at_index"><code class="docutils literal notranslate"><span class="pre">Table.get_row_at_index()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.get_rows"><code class="docutils literal notranslate"><span class="pre">Table.get_rows()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.get_total_row_range"><code class="docutils literal notranslate"><span class="pre">Table.get_total_row_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.get_worksheet"><code class="docutils literal notranslate"><span class="pre">Table.get_worksheet()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.highlight_first_column"><code class="docutils literal notranslate"><span class="pre">Table.highlight_first_column</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.highlight_last_column"><code class="docutils literal notranslate"><span class="pre">Table.highlight_last_column</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.legacy_id"><code class="docutils literal notranslate"><span class="pre">Table.legacy_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.name"><code class="docutils literal notranslate"><span class="pre">Table.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.object_id"><code class="docutils literal notranslate"><span class="pre">Table.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.parent"><code class="docutils literal notranslate"><span class="pre">Table.parent</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.reapply_filters"><code class="docutils literal notranslate"><span class="pre">Table.reapply_filters()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.session"><code class="docutils literal notranslate"><span class="pre">Table.session</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.show_banded_columns"><code class="docutils literal notranslate"><span class="pre">Table.show_banded_columns</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.show_banded_rows"><code class="docutils literal notranslate"><span class="pre">Table.show_banded_rows</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.show_filter_button"><code class="docutils literal notranslate"><span class="pre">Table.show_filter_button</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.show_headers"><code class="docutils literal notranslate"><span class="pre">Table.show_headers</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.show_totals"><code class="docutils literal notranslate"><span class="pre">Table.show_totals</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.style"><code class="docutils literal notranslate"><span class="pre">Table.style</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.Table.update"><code class="docutils literal notranslate"><span class="pre">Table.update()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.excel.TableColumn"><code class="docutils literal notranslate"><span class="pre">TableColumn</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.__init__"><code class="docutils literal notranslate"><span class="pre">TableColumn.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.apply_filter"><code class="docutils literal notranslate"><span class="pre">TableColumn.apply_filter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.clear_filter"><code class="docutils literal notranslate"><span class="pre">TableColumn.clear_filter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.delete"><code class="docutils literal notranslate"><span class="pre">TableColumn.delete()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.get_data_body_range"><code class="docutils literal notranslate"><span class="pre">TableColumn.get_data_body_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.get_filter"><code class="docutils literal notranslate"><span class="pre">TableColumn.get_filter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.get_header_row_range"><code class="docutils literal notranslate"><span class="pre">TableColumn.get_header_row_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.get_range"><code class="docutils literal notranslate"><span class="pre">TableColumn.get_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.get_total_row_range"><code class="docutils literal notranslate"><span class="pre">TableColumn.get_total_row_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.index"><code class="docutils literal notranslate"><span class="pre">TableColumn.index</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.name"><code class="docutils literal notranslate"><span class="pre">TableColumn.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.object_id"><code class="docutils literal notranslate"><span class="pre">TableColumn.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.session"><code class="docutils literal notranslate"><span class="pre">TableColumn.session</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.table"><code class="docutils literal notranslate"><span class="pre">TableColumn.table</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.update"><code class="docutils literal notranslate"><span class="pre">TableColumn.update()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableColumn.values"><code class="docutils literal notranslate"><span class="pre">TableColumn.values</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.excel.TableRow"><code class="docutils literal notranslate"><span class="pre">TableRow</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableRow.__init__"><code class="docutils literal notranslate"><span class="pre">TableRow.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableRow.delete"><code class="docutils literal notranslate"><span class="pre">TableRow.delete()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableRow.get_range"><code class="docutils literal notranslate"><span class="pre">TableRow.get_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableRow.index"><code class="docutils literal notranslate"><span class="pre">TableRow.index</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableRow.object_id"><code class="docutils literal notranslate"><span class="pre">TableRow.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableRow.session"><code class="docutils literal notranslate"><span class="pre">TableRow.session</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableRow.table"><code class="docutils literal notranslate"><span class="pre">TableRow.table</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableRow.update"><code class="docutils literal notranslate"><span class="pre">TableRow.update()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.TableRow.values"><code class="docutils literal notranslate"><span class="pre">TableRow.values</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.excel.WorkBook"><code class="docutils literal notranslate"><span class="pre">WorkBook</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.__init__"><code class="docutils literal notranslate"><span class="pre">WorkBook.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.add_named_range"><code class="docutils literal notranslate"><span class="pre">WorkBook.add_named_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.add_worksheet"><code class="docutils literal notranslate"><span class="pre">WorkBook.add_worksheet()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.delete_worksheet"><code class="docutils literal notranslate"><span class="pre">WorkBook.delete_worksheet()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.get_named_range"><code class="docutils literal notranslate"><span class="pre">WorkBook.get_named_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.get_named_ranges"><code class="docutils literal notranslate"><span class="pre">WorkBook.get_named_ranges()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.get_table"><code class="docutils literal notranslate"><span class="pre">WorkBook.get_table()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.get_tables"><code class="docutils literal notranslate"><span class="pre">WorkBook.get_tables()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.get_workbookapplication"><code class="docutils literal notranslate"><span class="pre">WorkBook.get_workbookapplication()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.get_worksheet"><code class="docutils literal notranslate"><span class="pre">WorkBook.get_worksheet()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.get_worksheets"><code class="docutils literal notranslate"><span class="pre">WorkBook.get_worksheets()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.invoke_function"><code class="docutils literal notranslate"><span class="pre">WorkBook.invoke_function()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.name"><code class="docutils literal notranslate"><span class="pre">WorkBook.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.object_id"><code class="docutils literal notranslate"><span class="pre">WorkBook.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkBook.session"><code class="docutils literal notranslate"><span class="pre">WorkBook.session</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.excel.WorkSheet"><code class="docutils literal notranslate"><span class="pre">WorkSheet</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.__init__"><code class="docutils literal notranslate"><span class="pre">WorkSheet.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.add_named_range"><code class="docutils literal notranslate"><span class="pre">WorkSheet.add_named_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.add_table"><code class="docutils literal notranslate"><span class="pre">WorkSheet.add_table()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.append_rows"><code class="docutils literal notranslate"><span class="pre">WorkSheet.append_rows()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.delete"><code class="docutils literal notranslate"><span class="pre">WorkSheet.delete()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.get_cell"><code class="docutils literal notranslate"><span class="pre">WorkSheet.get_cell()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.get_named_range"><code class="docutils literal notranslate"><span class="pre">WorkSheet.get_named_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.get_range"><code class="docutils literal notranslate"><span class="pre">WorkSheet.get_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.get_table"><code class="docutils literal notranslate"><span class="pre">WorkSheet.get_table()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.get_tables"><code class="docutils literal notranslate"><span class="pre">WorkSheet.get_tables()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.get_used_range"><code class="docutils literal notranslate"><span class="pre">WorkSheet.get_used_range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.name"><code class="docutils literal notranslate"><span class="pre">WorkSheet.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.object_id"><code class="docutils literal notranslate"><span class="pre">WorkSheet.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.position"><code class="docutils literal notranslate"><span class="pre">WorkSheet.position</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.remove_sheet_name_from_address"><code class="docutils literal notranslate"><span class="pre">WorkSheet.remove_sheet_name_from_address()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.session"><code class="docutils literal notranslate"><span class="pre">WorkSheet.session</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.update"><code class="docutils literal notranslate"><span class="pre">WorkSheet.update()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.update_cells"><code class="docutils literal notranslate"><span class="pre">WorkSheet.update_cells()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.visibility"><code class="docutils literal notranslate"><span class="pre">WorkSheet.visibility</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkSheet.workbook"><code class="docutils literal notranslate"><span class="pre">WorkSheet.workbook</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.excel.WorkbookApplication"><code class="docutils literal notranslate"><span class="pre">WorkbookApplication</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookApplication.__init__"><code class="docutils literal notranslate"><span class="pre">WorkbookApplication.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookApplication.get_details"><code class="docutils literal notranslate"><span class="pre">WorkbookApplication.get_details()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookApplication.parent"><code class="docutils literal notranslate"><span class="pre">WorkbookApplication.parent</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookApplication.run_calculations"><code class="docutils literal notranslate"><span class="pre">WorkbookApplication.run_calculations()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.excel.WorkbookSession"><code class="docutils literal notranslate"><span class="pre">WorkbookSession</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.__init__"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.close_session"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.close_session()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.create_session"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.create_session()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.delete"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.delete()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.get"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.get()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.inactivity_limit"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.inactivity_limit</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.last_activity"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.last_activity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.patch"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.patch()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.persist"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.persist</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.post"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.post()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.prepare_request"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.prepare_request()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.put"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.put()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.refresh_session"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.refresh_session()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.excel.WorkbookSession.session_id"><code class="docutils literal notranslate"><span class="pre">WorkbookSession.session_id</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="group.html">Group</a></li>
<li class="toctree-l2"><a class="reference internal" href="mailbox.html">Mailbox</a></li>
<li class="toctree-l2"><a class="reference internal" href="message.html">Message</a></li>
<li class="toctree-l2"><a class="reference internal" href="onedrive.html">One Drive</a></li>
<li class="toctree-l2"><a class="reference internal" href="planner.html">Planner</a></li>
<li class="toctree-l2"><a class="reference internal" href="sharepoint.html">Sharepoint</a></li>
<li class="toctree-l2"><a class="reference internal" href="tasks.html">Tasks</a></li>
<li class="toctree-l2"><a class="reference internal" href="teams.html">Teams</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
</ul>
</li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">O365</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="../api.html">O365 API</a></li>
      <li class="breadcrumb-item active">Excel</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../_sources/api/excel.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation">
        <a href="directory.html" class="btn btn-neutral float-left" title="Directory" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="group.html" class="btn btn-neutral float-right" title="Group" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  </div>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="excel">
<h1>Excel<a class="headerlink" href="#excel" title="Link to this heading"></a></h1>
<p id="module-O365.excel">2019-04-15
Note: Support for workbooks stored in OneDrive Consumer platform is still not available.
At this time, only the files stored in business platform is supported by Excel REST APIs.</p>
<dl class="py exception">
<dt class="sig sig-object py" id="O365.excel.FunctionException">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.excel.</span></span><span class="sig-name descname"><span class="pre">FunctionException</span></span><a class="reference internal" href="../_modules/O365/excel.html#FunctionException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.FunctionException" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.excel.NamedRange">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.excel.</span></span><span class="sig-name descname"><span class="pre">NamedRange</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#NamedRange"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.NamedRange" title="Link to this definition"></a></dt>
<dd><p>Represents a defined name for a range of cells or value</p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.NamedRange.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#NamedRange.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.NamedRange.__init__" title="Link to this definition"></a></dt>
<dd><p>Object initialization</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – A protocol class or instance to be used with
this connection</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – main_resource to be used in these API
communications</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.NamedRange.comment">
<span class="sig-name descname"><span class="pre">comment</span></span><a class="headerlink" href="#O365.excel.NamedRange.comment" title="Link to this definition"></a></dt>
<dd><p>The comment associated with this name. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.NamedRange.data_type">
<span class="sig-name descname"><span class="pre">data_type</span></span><a class="headerlink" href="#O365.excel.NamedRange.data_type" title="Link to this definition"></a></dt>
<dd><p>The type of reference is associated with the name.
Possible values are: String, Integer, Double, Boolean, Range. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.NamedRange.get_range">
<span class="sig-name descname"><span class="pre">get_range</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#NamedRange.get_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.NamedRange.get_range" title="Link to this definition"></a></dt>
<dd><p>Returns the Range instance this named range refers to</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.NamedRange.name">
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#O365.excel.NamedRange.name" title="Link to this definition"></a></dt>
<dd><p>The name of the object. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.NamedRange.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.excel.NamedRange.object_id" title="Link to this definition"></a></dt>
<dd><p>Id of the named range <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.NamedRange.scope">
<span class="sig-name descname"><span class="pre">scope</span></span><a class="headerlink" href="#O365.excel.NamedRange.scope" title="Link to this definition"></a></dt>
<dd><p>Indicates whether the name is scoped to the workbook or to a specific worksheet.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.NamedRange.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#NamedRange.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.NamedRange.update" title="Link to this definition"></a></dt>
<dd><p>Updates this named range
:param bool visible: Specifies whether the object is visible or not
:param str comment: Represents the comment associated with this name
:return: Success or Failure</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.NamedRange.value">
<span class="sig-name descname"><span class="pre">value</span></span><a class="headerlink" href="#O365.excel.NamedRange.value" title="Link to this definition"></a></dt>
<dd><p>The formula that the name is defined to refer to.
For example, =Sheet14!$B$2:$H$12 and =4.75. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.NamedRange.visible">
<span class="sig-name descname"><span class="pre">visible</span></span><a class="headerlink" href="#O365.excel.NamedRange.visible" title="Link to this definition"></a></dt>
<dd><p>Indicates whether the object is visible. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> bool</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.excel.Range">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.excel.</span></span><span class="sig-name descname"><span class="pre">Range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range" title="Link to this definition"></a></dt>
<dd><p>An Excel Range</p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.__init__" title="Link to this definition"></a></dt>
<dd><p>Object initialization</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – A protocol class or instance to be used with
this connection</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – main_resource to be used in these API
communications</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Range.address">
<span class="sig-name descname"><span class="pre">address</span></span><a class="headerlink" href="#O365.excel.Range.address" title="Link to this definition"></a></dt>
<dd><p>Represents the range reference in A1-style.
Address value contains the Sheet reference
(for example, Sheet1!A1:B4). <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Range.address_local">
<span class="sig-name descname"><span class="pre">address_local</span></span><a class="headerlink" href="#O365.excel.Range.address_local" title="Link to this definition"></a></dt>
<dd><p>Represents range reference for the specified range in the language of the user.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Range.cell_count">
<span class="sig-name descname"><span class="pre">cell_count</span></span><a class="headerlink" href="#O365.excel.Range.cell_count" title="Link to this definition"></a></dt>
<dd><p>Number of cells in the range. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.clear">
<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">apply_to</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'all'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.clear"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.clear" title="Link to this definition"></a></dt>
<dd><p>Clear range values, format, fill, border, etc.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>apply_to</strong> (<em>str</em>) – Optional. Determines the type of clear action.
The possible values are: all, formats, contents.</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Range.column_count">
<span class="sig-name descname"><span class="pre">column_count</span></span><a class="headerlink" href="#O365.excel.Range.column_count" title="Link to this definition"></a></dt>
<dd><p>Represents the total number of columns in the range. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.Range.column_hidden">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">column_hidden</span></span><a class="headerlink" href="#O365.excel.Range.column_hidden" title="Link to this definition"></a></dt>
<dd><p>Indicates whether all columns of the current range are hidden.</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the column_hidden</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the column_hidden</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Range.column_index">
<span class="sig-name descname"><span class="pre">column_index</span></span><a class="headerlink" href="#O365.excel.Range.column_index" title="Link to this definition"></a></dt>
<dd><p>Represents the column number of the first cell in the range. Zero-indexed.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shift</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'up'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.delete" title="Link to this definition"></a></dt>
<dd><p>Deletes the cells associated with the range.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>shift</strong> (<em>str</em>) – Optional. Specifies which way to shift the cells.
The possible values are: up, left.</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.Range.formulas">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">formulas</span></span><a class="headerlink" href="#O365.excel.Range.formulas" title="Link to this definition"></a></dt>
<dd><p>Represents the formula in A1-style notation.</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the formulas</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the formulas</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>any</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.Range.formulas_local">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">formulas_local</span></span><a class="headerlink" href="#O365.excel.Range.formulas_local" title="Link to this definition"></a></dt>
<dd><p>Represents the formula in A1-style notation, in the user’s language
and number-formatting locale. For example, the English “=SUM(A1, 1.5)”
formula would become “=SUMME(A1; 1,5)” in German.</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the formulas_local</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the formulas_local</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list[list]</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.Range.formulas_r1_c1">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">formulas_r1_c1</span></span><a class="headerlink" href="#O365.excel.Range.formulas_r1_c1" title="Link to this definition"></a></dt>
<dd><p>Represents the formula in R1C1-style notation.</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the formulas_r1_c1</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the formulas_r1_c1</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list[list]</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_bounding_rect">
<span class="sig-name descname"><span class="pre">get_bounding_rect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_bounding_rect"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_bounding_rect" title="Link to this definition"></a></dt>
<dd><p>Gets the smallest range object that encompasses the given ranges.
For example, the GetBoundingRect of “B2:C5” and “D10:E15” is “B2:E16”.
:param str address: another address to retrieve it’s bounding rect</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_cell">
<span class="sig-name descname"><span class="pre">get_cell</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">row</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">column</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_cell"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_cell" title="Link to this definition"></a></dt>
<dd><p>Gets the range object containing the single cell based on row and column numbers.
:param int row: the row number
:param int column: the column number
:return: a Range instance</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_column">
<span class="sig-name descname"><span class="pre">get_column</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_column"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_column" title="Link to this definition"></a></dt>
<dd><p>Returns a column whitin the range
:param int index: the index of the column. zero indexed
:return: a Range</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_columns_after">
<span class="sig-name descname"><span class="pre">get_columns_after</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">columns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_columns_after"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_columns_after" title="Link to this definition"></a></dt>
<dd><p>Gets a certain number of columns to the right of the given range.
:param int columns: Optional. The number of columns to include in the resulting range.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_columns_before">
<span class="sig-name descname"><span class="pre">get_columns_before</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">columns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_columns_before"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_columns_before" title="Link to this definition"></a></dt>
<dd><p>Gets a certain number of columns to the left  of the given range.
:param int columns: Optional. The number of columns to include in the resulting range.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_entire_column">
<span class="sig-name descname"><span class="pre">get_entire_column</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_entire_column"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_entire_column" title="Link to this definition"></a></dt>
<dd><p>Gets a Range that represents the entire column of the range.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_format">
<span class="sig-name descname"><span class="pre">get_format</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_format"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_format" title="Link to this definition"></a></dt>
<dd><p>Returns a RangeFormat instance with the format of this range</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_intersection">
<span class="sig-name descname"><span class="pre">get_intersection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_intersection"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_intersection" title="Link to this definition"></a></dt>
<dd><p>Gets the Range that represents the rectangular intersection of the given ranges.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>address</strong> – the address range you want ot intersect with.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Range</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_last_cell">
<span class="sig-name descname"><span class="pre">get_last_cell</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_last_cell"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_last_cell" title="Link to this definition"></a></dt>
<dd><p>Gets the last cell within the range.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_last_column">
<span class="sig-name descname"><span class="pre">get_last_column</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_last_column"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_last_column" title="Link to this definition"></a></dt>
<dd><p>Gets the last column within the range.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_last_row">
<span class="sig-name descname"><span class="pre">get_last_row</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_last_row"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_last_row" title="Link to this definition"></a></dt>
<dd><p>Gets the last row within the range.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_offset_range">
<span class="sig-name descname"><span class="pre">get_offset_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">row_offset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">column_offset</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_offset_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_offset_range" title="Link to this definition"></a></dt>
<dd><dl class="simple">
<dt>Gets an object which represents a range that’s offset from the specified range.</dt><dd><p>The dimension of the returned range will match this range.
If the resulting range is forced outside the bounds of the worksheet grid,
an exception will be thrown.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>row_offset</strong> (<em>int</em>) – The number of rows (positive, negative, or 0)
by which the range is to be offset.</p></li>
<li><p><strong>column_offset</strong> (<em>int</em>) – he number of columns (positive, negative, or 0)
by which the range is to be offset.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Range</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_resized_range">
<span class="sig-name descname"><span class="pre">get_resized_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rows</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">columns</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_resized_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_resized_range" title="Link to this definition"></a></dt>
<dd><p>Gets a range object similar to the current range object,
but with its bottom-right corner expanded (or contracted)
by some number of rows and columns.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>rows</strong> (<em>int</em>) – The number of rows by which to expand the
bottom-right corner, relative to the current range.</p></li>
<li><p><strong>columns</strong> (<em>int</em>) – The number of columns by which to expand the
bottom-right corner, relative to the current range.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Range</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_row">
<span class="sig-name descname"><span class="pre">get_row</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_row"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_row" title="Link to this definition"></a></dt>
<dd><p>Gets a row contained in the range.
:param int index: Row number of the range to be retrieved.
:return: Range</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_rows_above">
<span class="sig-name descname"><span class="pre">get_rows_above</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rows</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_rows_above"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_rows_above" title="Link to this definition"></a></dt>
<dd><p>Gets a certain number of rows above a given range.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>rows</strong> (<em>int</em>) – Optional. The number of rows to include in the resulting range.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Range</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_rows_below">
<span class="sig-name descname"><span class="pre">get_rows_below</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rows</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_rows_below"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_rows_below" title="Link to this definition"></a></dt>
<dd><p>Gets a certain number of rows below a given range.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>rows</strong> (<em>int</em>) – Optional. The number of rows to include in the resulting range.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Range</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_used_range">
<span class="sig-name descname"><span class="pre">get_used_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">only_values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_used_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_used_range" title="Link to this definition"></a></dt>
<dd><p>Returns the used range of the given range object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>only_values</strong> (<em>bool</em>) – Optional. Defaults to True.
Considers only cells with values as used cells (ignores formatting).</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Range</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.get_worksheet">
<span class="sig-name descname"><span class="pre">get_worksheet</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.get_worksheet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.get_worksheet" title="Link to this definition"></a></dt>
<dd><p>Returns this range worksheet</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Range.hidden">
<span class="sig-name descname"><span class="pre">hidden</span></span><a class="headerlink" href="#O365.excel.Range.hidden" title="Link to this definition"></a></dt>
<dd><p>Represents if all cells of the current range are hidden. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> bool</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.insert_range">
<span class="sig-name descname"><span class="pre">insert_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shift</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.insert_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.insert_range" title="Link to this definition"></a></dt>
<dd><p>Inserts a cell or a range of cells into the worksheet in place of this range,
and shifts the other cells to make space.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>shift</strong> (<em>str</em>) – Specifies which way to shift the cells. The possible values are: down, right.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>new Range instance at the now blank space</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.merge">
<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">across</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.merge"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.merge" title="Link to this definition"></a></dt>
<dd><p>Merge the range cells into one region in the worksheet.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>across</strong> (<em>bool</em>) – Optional. Set True to merge cells in each row of the
specified range as separate merged cells.</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.Range.number_format">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">number_format</span></span><a class="headerlink" href="#O365.excel.Range.number_format" title="Link to this definition"></a></dt>
<dd><p>Represents Excel’s number format code for the given cell.</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the number_format</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the number_fromat</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list[list]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Range.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.excel.Range.object_id" title="Link to this definition"></a></dt>
<dd><p>The id of the range. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Range.row_count">
<span class="sig-name descname"><span class="pre">row_count</span></span><a class="headerlink" href="#O365.excel.Range.row_count" title="Link to this definition"></a></dt>
<dd><p>Returns the total number of rows in the range. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.Range.row_hidden">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">row_hidden</span></span><a class="headerlink" href="#O365.excel.Range.row_hidden" title="Link to this definition"></a></dt>
<dd><p>Indicates whether all rows of the current range are hidden.</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the row_hidden</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the row_hidden</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Range.row_index">
<span class="sig-name descname"><span class="pre">row_index</span></span><a class="headerlink" href="#O365.excel.Range.row_index" title="Link to this definition"></a></dt>
<dd><p>Returns the row number of the first cell in the range. Zero-indexed.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Range.text">
<span class="sig-name descname"><span class="pre">text</span></span><a class="headerlink" href="#O365.excel.Range.text" title="Link to this definition"></a></dt>
<dd><p>Text values of the specified range. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.to_api_data">
<span class="sig-name descname"><span class="pre">to_api_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">restrict_keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.to_api_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.to_api_data" title="Link to this definition"></a></dt>
<dd><p>Returns a dict to communicate with the server</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>restrict_keys</strong> – a set of keys to restrict the returned data to</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.unmerge">
<span class="sig-name descname"><span class="pre">unmerge</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.unmerge"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.unmerge" title="Link to this definition"></a></dt>
<dd><p>Unmerge the range cells into separate cells.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Range.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Range.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Range.update" title="Link to this definition"></a></dt>
<dd><p>Update this range</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Range.value_types">
<span class="sig-name descname"><span class="pre">value_types</span></span><a class="headerlink" href="#O365.excel.Range.value_types" title="Link to this definition"></a></dt>
<dd><p>Represents the type of data of each cell.
The possible values are: Unknown, Empty, String,
Integer, Double, Boolean, Error. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> list[list]</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.Range.values">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">values</span></span><a class="headerlink" href="#O365.excel.Range.values" title="Link to this definition"></a></dt>
<dd><p>Represents the raw values of the specified range.
The data returned can be of type string, number, or a Boolean.
Cell that contains an error returns the error string.</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the number_format</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the number_fromat</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list[list]</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.excel.RangeFormat">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.excel.</span></span><span class="sig-name descname"><span class="pre">RangeFormat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#RangeFormat"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.RangeFormat" title="Link to this definition"></a></dt>
<dd><p>A format applied to a range</p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#RangeFormat.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.RangeFormat.__init__" title="Link to this definition"></a></dt>
<dd><p>Object initialization</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – A protocol class or instance to be used with
this connection</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – main_resource to be used in these API
communications</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.auto_fit_columns">
<span class="sig-name descname"><span class="pre">auto_fit_columns</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#RangeFormat.auto_fit_columns"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.RangeFormat.auto_fit_columns" title="Link to this definition"></a></dt>
<dd><p>Changes the width of the columns of the current range
to achieve the best fit, based on the current data in the columns</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.auto_fit_rows">
<span class="sig-name descname"><span class="pre">auto_fit_rows</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#RangeFormat.auto_fit_rows"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.RangeFormat.auto_fit_rows" title="Link to this definition"></a></dt>
<dd><p>Changes the width of the rows of the current range
to achieve the best fit, based on the current data in the rows</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.background_color">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">background_color</span></span><a class="headerlink" href="#O365.excel.RangeFormat.background_color" title="Link to this definition"></a></dt>
<dd><p>The background color of the range</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the background_color</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the background_color</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>UnsentSentinel</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.column_width">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">column_width</span></span><a class="headerlink" href="#O365.excel.RangeFormat.column_width" title="Link to this definition"></a></dt>
<dd><p>The width of all columns within the range</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the column_width</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the column_width</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.font">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">font</span></span><a class="headerlink" href="#O365.excel.RangeFormat.font" title="Link to this definition"></a></dt>
<dd><p>Returns the font object defined on the overall range selected</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the font</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the font</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#O365.excel.RangeFormatFont" title="O365.excel.RangeFormatFont">RangeFormatFont</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.horizontal_alignment">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">horizontal_alignment</span></span><a class="headerlink" href="#O365.excel.RangeFormat.horizontal_alignment" title="Link to this definition"></a></dt>
<dd><p>The horizontal alignment for the specified object.
Possible values are: General, Left, Center, Right, Fill, Justify,
CenterAcrossSelection, Distributed.</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the vertical_alignment</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the vertical_alignment</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.range">
<span class="sig-name descname"><span class="pre">range</span></span><a class="headerlink" href="#O365.excel.RangeFormat.range" title="Link to this definition"></a></dt>
<dd><p>The range of the range format. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> range</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.row_height">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">row_height</span></span><a class="headerlink" href="#O365.excel.RangeFormat.row_height" title="Link to this definition"></a></dt>
<dd><p>The height of all rows in the range.</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the row_height</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the row_height</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.session">
<span class="sig-name descname"><span class="pre">session</span></span><a class="headerlink" href="#O365.excel.RangeFormat.session" title="Link to this definition"></a></dt>
<dd><p>The session for the range format. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.set_borders">
<span class="sig-name descname"><span class="pre">set_borders</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">side_style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#RangeFormat.set_borders"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.RangeFormat.set_borders" title="Link to this definition"></a></dt>
<dd><p>Sets the border of this range</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.to_api_data">
<span class="sig-name descname"><span class="pre">to_api_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">restrict_keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#RangeFormat.to_api_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.RangeFormat.to_api_data" title="Link to this definition"></a></dt>
<dd><p>Returns a dict to communicate with the server</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>restrict_keys</strong> – a set of keys to restrict the returned data to</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#RangeFormat.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.RangeFormat.update" title="Link to this definition"></a></dt>
<dd><p>Updates this range format</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.vertical_alignment">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">vertical_alignment</span></span><a class="headerlink" href="#O365.excel.RangeFormat.vertical_alignment" title="Link to this definition"></a></dt>
<dd><p>The vertical alignment for the specified object.
Possible values are: Top, Center, Bottom, Justify, Distributed.</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the vertical_alignment</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the vertical_alignment</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormat.wrap_text">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wrap_text</span></span><a class="headerlink" href="#O365.excel.RangeFormat.wrap_text" title="Link to this definition"></a></dt>
<dd><p>Indicates whether Excel wraps the text in the object</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the wrap_text</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the wrap_text</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.excel.RangeFormatFont">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.excel.</span></span><span class="sig-name descname"><span class="pre">RangeFormatFont</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#RangeFormatFont"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.RangeFormatFont" title="Link to this definition"></a></dt>
<dd><p>A font format applied to a range</p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.RangeFormatFont.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#RangeFormatFont.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.RangeFormatFont.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormatFont.bold">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">bold</span></span><a class="headerlink" href="#O365.excel.RangeFormatFont.bold" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormatFont.color">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">color</span></span><a class="headerlink" href="#O365.excel.RangeFormatFont.color" title="Link to this definition"></a></dt>
<dd><p>The color of the range format font</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the color</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the color</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormatFont.italic">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">italic</span></span><a class="headerlink" href="#O365.excel.RangeFormatFont.italic" title="Link to this definition"></a></dt>
<dd><p>Is range format font in italics</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the italic</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the italic</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormatFont.name">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#O365.excel.RangeFormatFont.name" title="Link to this definition"></a></dt>
<dd><p>The name of the range format font</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the name</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the name</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.RangeFormatFont.parent">
<span class="sig-name descname"><span class="pre">parent</span></span><a class="headerlink" href="#O365.excel.RangeFormatFont.parent" title="Link to this definition"></a></dt>
<dd><p>The parent of the range format font. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> parent</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormatFont.size">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">size</span></span><a class="headerlink" href="#O365.excel.RangeFormatFont.size" title="Link to this definition"></a></dt>
<dd><p>The size of the range format font</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the size</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the size</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.RangeFormatFont.to_api_data">
<span class="sig-name descname"><span class="pre">to_api_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">restrict_keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#RangeFormatFont.to_api_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.RangeFormatFont.to_api_data" title="Link to this definition"></a></dt>
<dd><p>Returns a dict to communicate with the server</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>restrict_keys</strong> – a set of keys to restrict the returned data to</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="O365.excel.RangeFormatFont.underline">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">underline</span></span><a class="headerlink" href="#O365.excel.RangeFormatFont.underline" title="Link to this definition"></a></dt>
<dd><p>Is range format font underlined</p>
<dl class="field-list simple">
<dt class="field-odd">Getter<span class="colon">:</span></dt>
<dd class="field-odd"><p>get the underline</p>
</dd>
<dt class="field-even">Setter<span class="colon">:</span></dt>
<dd class="field-even"><p>set the underline</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.excel.Table">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.excel.</span></span><span class="sig-name descname"><span class="pre">Table</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table" title="Link to this definition"></a></dt>
<dd><p>An Excel Table</p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.__init__" title="Link to this definition"></a></dt>
<dd><p>Object initialization</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – A protocol class or instance to be used with
this connection</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – main_resource to be used in these API
communications</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.add_column">
<span class="sig-name descname"><span class="pre">add_column</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.add_column"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.add_column" title="Link to this definition"></a></dt>
<dd><p>Adds a column to the table
:param str name: the name of the column
:param int index: the index at which the column should be added. Defaults to 0.
:param list values: a two dimension array of values to add to the column</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.add_rows">
<span class="sig-name descname"><span class="pre">add_rows</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.add_rows"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.add_rows" title="Link to this definition"></a></dt>
<dd><p>Add rows to this table.</p>
<blockquote>
<div><p>Multiple rows can be added at once.
This request might occasionally receive a 504 HTTP error.
The appropriate response to this error is to repeat the request.</p>
</div></blockquote>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>values</strong> (<em>list</em>) – Optional. a 1 or 2 dimensional array of values to add</p></li>
<li><p><strong>index</strong> (<em>int</em>) – Optional. Specifies the relative position of the new row.
If null, the addition happens at the end.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.clear_filters">
<span class="sig-name descname"><span class="pre">clear_filters</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.clear_filters"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.clear_filters" title="Link to this definition"></a></dt>
<dd><p>Clears all the filters currently applied on the table.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.convert_to_range">
<span class="sig-name descname"><span class="pre">convert_to_range</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.convert_to_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.convert_to_range" title="Link to this definition"></a></dt>
<dd><p>Converts the table into a normal range of cells. All data is preserved.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.delete" title="Link to this definition"></a></dt>
<dd><p>Deletes this table</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.delete_column">
<span class="sig-name descname"><span class="pre">delete_column</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id_or_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.delete_column"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.delete_column" title="Link to this definition"></a></dt>
<dd><p>Deletes a Column by its id or name
:param id_or_name: the id or name of the column
:return bool: Success or Failure</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.delete_row">
<span class="sig-name descname"><span class="pre">delete_row</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.delete_row"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.delete_row" title="Link to this definition"></a></dt>
<dd><p>Deletes a Row by it’s index
:param int index: the index of the row. zero indexed
:return bool: Success or Failure</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.get_column">
<span class="sig-name descname"><span class="pre">get_column</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id_or_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.get_column"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.get_column" title="Link to this definition"></a></dt>
<dd><p>Gets a column from this table by id or name
:param id_or_name: the id or name of the column
:return: WorkBookTableColumn</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.get_column_at_index">
<span class="sig-name descname"><span class="pre">get_column_at_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.get_column_at_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.get_column_at_index" title="Link to this definition"></a></dt>
<dd><p>Returns a table column by it’s index
:param int index: the zero-indexed position of the column in the table</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.get_columns">
<span class="sig-name descname"><span class="pre">get_columns</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">top</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.get_columns"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.get_columns" title="Link to this definition"></a></dt>
<dd><p>Return the columns of this table
:param int top: specify n columns to retrieve
:param int skip: specify n columns to skip</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.get_data_body_range">
<span class="sig-name descname"><span class="pre">get_data_body_range</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.get_data_body_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.get_data_body_range" title="Link to this definition"></a></dt>
<dd><p>Gets the range object associated with the data body of the table</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.get_header_row_range">
<span class="sig-name descname"><span class="pre">get_header_row_range</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.get_header_row_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.get_header_row_range" title="Link to this definition"></a></dt>
<dd><p>Gets the range object associated with the header row of the table</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.get_range">
<span class="sig-name descname"><span class="pre">get_range</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.get_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.get_range" title="Link to this definition"></a></dt>
<dd><p>Gets the range object associated with the entire table</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.get_row">
<span class="sig-name descname"><span class="pre">get_row</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.get_row"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.get_row" title="Link to this definition"></a></dt>
<dd><p>Returns a Row instance at an index</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.get_row_at_index">
<span class="sig-name descname"><span class="pre">get_row_at_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.get_row_at_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.get_row_at_index" title="Link to this definition"></a></dt>
<dd><p>Returns a table row by it’s index
:param int index: the zero-indexed position of the row in the table</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.get_rows">
<span class="sig-name descname"><span class="pre">get_rows</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">top</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.get_rows"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.get_rows" title="Link to this definition"></a></dt>
<dd><p>Return the rows of this table
:param int top: specify n rows to retrieve
:param int skip: specify n rows to skip
:rtype: TableRow</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.get_total_row_range">
<span class="sig-name descname"><span class="pre">get_total_row_range</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.get_total_row_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.get_total_row_range" title="Link to this definition"></a></dt>
<dd><p>Gets the range object associated with the totals row of the table</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.get_worksheet">
<span class="sig-name descname"><span class="pre">get_worksheet</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.get_worksheet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.get_worksheet" title="Link to this definition"></a></dt>
<dd><p>Returns this table worksheet</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.highlight_first_column">
<span class="sig-name descname"><span class="pre">highlight_first_column</span></span><a class="headerlink" href="#O365.excel.Table.highlight_first_column" title="Link to this definition"></a></dt>
<dd><p>Indicates whether the first column contains special formatting. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> bool</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.highlight_last_column">
<span class="sig-name descname"><span class="pre">highlight_last_column</span></span><a class="headerlink" href="#O365.excel.Table.highlight_last_column" title="Link to this definition"></a></dt>
<dd><p>Indicates whether the last column contains special formatting. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> bool</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.legacy_id">
<span class="sig-name descname"><span class="pre">legacy_id</span></span><a class="headerlink" href="#O365.excel.Table.legacy_id" title="Link to this definition"></a></dt>
<dd><p>A legacy identifier used in older Excel clients.  <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.name">
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#O365.excel.Table.name" title="Link to this definition"></a></dt>
<dd><p>The name of the table. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.excel.Table.object_id" title="Link to this definition"></a></dt>
<dd><p>The unique identifier for the table in the workbook. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.parent">
<span class="sig-name descname"><span class="pre">parent</span></span><a class="headerlink" href="#O365.excel.Table.parent" title="Link to this definition"></a></dt>
<dd><p>Parent of the table. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> parent</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.reapply_filters">
<span class="sig-name descname"><span class="pre">reapply_filters</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.reapply_filters"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.reapply_filters" title="Link to this definition"></a></dt>
<dd><p>Reapplies all the filters currently on the table.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.session">
<span class="sig-name descname"><span class="pre">session</span></span><a class="headerlink" href="#O365.excel.Table.session" title="Link to this definition"></a></dt>
<dd><p>Session of the table. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> session</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.show_banded_columns">
<span class="sig-name descname"><span class="pre">show_banded_columns</span></span><a class="headerlink" href="#O365.excel.Table.show_banded_columns" title="Link to this definition"></a></dt>
<dd><p>Indicates whether the columns show banded formatting in which odd columns
are highlighted differently from even ones to make reading the table easier.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> bool</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.show_banded_rows">
<span class="sig-name descname"><span class="pre">show_banded_rows</span></span><a class="headerlink" href="#O365.excel.Table.show_banded_rows" title="Link to this definition"></a></dt>
<dd><p>The name of the table column. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.show_filter_button">
<span class="sig-name descname"><span class="pre">show_filter_button</span></span><a class="headerlink" href="#O365.excel.Table.show_filter_button" title="Link to this definition"></a></dt>
<dd><p>Indicates whether the rows show banded formatting in which odd rows
are highlighted differently from even ones to make reading the table easier.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> bool</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.show_headers">
<span class="sig-name descname"><span class="pre">show_headers</span></span><a class="headerlink" href="#O365.excel.Table.show_headers" title="Link to this definition"></a></dt>
<dd><p>Indicates whether the header row is visible or not <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> bool</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.show_totals">
<span class="sig-name descname"><span class="pre">show_totals</span></span><a class="headerlink" href="#O365.excel.Table.show_totals" title="Link to this definition"></a></dt>
<dd><p>Indicates whether the total row is visible or not.  <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> bool</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.Table.style">
<span class="sig-name descname"><span class="pre">style</span></span><a class="headerlink" href="#O365.excel.Table.style" title="Link to this definition"></a></dt>
<dd><p>A constant value that represents the Table style <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.Table.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_totals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#Table.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.Table.update" title="Link to this definition"></a></dt>
<dd><p>Updates this table
:param str name: the name of the table
:param bool show_headers: whether or not to show the headers
:param bool show_totals: whether or not to show the totals
:param str style: the style of the table
:return: Success or Failure</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.excel.TableColumn">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.excel.</span></span><span class="sig-name descname"><span class="pre">TableColumn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableColumn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableColumn" title="Link to this definition"></a></dt>
<dd><p>An Excel Table Column</p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableColumn.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableColumn.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableColumn.__init__" title="Link to this definition"></a></dt>
<dd><p>Object initialization</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – A protocol class or instance to be used with
this connection</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – main_resource to be used in these API
communications</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableColumn.apply_filter">
<span class="sig-name descname"><span class="pre">apply_filter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">criteria</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableColumn.apply_filter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableColumn.apply_filter" title="Link to this definition"></a></dt>
<dd><p>Apply the given filter criteria on the given column.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>criteria</strong> (<em>str</em>) – <p>the criteria to apply</p>
<p>Example:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="w">    </span><span class="nt">&quot;color&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;string&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="nt">&quot;criterion1&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;string&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="nt">&quot;criterion2&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;string&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="nt">&quot;dynamicCriteria&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;string&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="nt">&quot;filterOn&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;string&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="nt">&quot;icon&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;@odata.type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;microsoft.graph.workbookIcon&quot;</span><span class="p">},</span>
<span class="w">    </span><span class="nt">&quot;values&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;@odata.type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;microsoft.graph.Json&quot;</span><span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableColumn.clear_filter">
<span class="sig-name descname"><span class="pre">clear_filter</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableColumn.clear_filter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableColumn.clear_filter" title="Link to this definition"></a></dt>
<dd><p>Clears the filter applied to this column</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableColumn.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableColumn.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableColumn.delete" title="Link to this definition"></a></dt>
<dd><p>Deletes this table Column</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableColumn.get_data_body_range">
<span class="sig-name descname"><span class="pre">get_data_body_range</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableColumn.get_data_body_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableColumn.get_data_body_range" title="Link to this definition"></a></dt>
<dd><p>Gets the range object associated with the data body of the column</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableColumn.get_filter">
<span class="sig-name descname"><span class="pre">get_filter</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableColumn.get_filter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableColumn.get_filter" title="Link to this definition"></a></dt>
<dd><p>Returns the filter applie to this column</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableColumn.get_header_row_range">
<span class="sig-name descname"><span class="pre">get_header_row_range</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableColumn.get_header_row_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableColumn.get_header_row_range" title="Link to this definition"></a></dt>
<dd><p>Gets the range object associated with the header row of the column</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableColumn.get_range">
<span class="sig-name descname"><span class="pre">get_range</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableColumn.get_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableColumn.get_range" title="Link to this definition"></a></dt>
<dd><p>Gets the range object associated with the entire column</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableColumn.get_total_row_range">
<span class="sig-name descname"><span class="pre">get_total_row_range</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableColumn.get_total_row_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableColumn.get_total_row_range" title="Link to this definition"></a></dt>
<dd><p>Gets the range object associated with the totals row of the column</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.TableColumn.index">
<span class="sig-name descname"><span class="pre">index</span></span><a class="headerlink" href="#O365.excel.TableColumn.index" title="Link to this definition"></a></dt>
<dd><p>TThe index of the column within the columns collection of the table. Zero-indexed.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.TableColumn.name">
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#O365.excel.TableColumn.name" title="Link to this definition"></a></dt>
<dd><p>The name of the table column. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.TableColumn.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.excel.TableColumn.object_id" title="Link to this definition"></a></dt>
<dd><p>Id of the Table Column|br| <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.TableColumn.session">
<span class="sig-name descname"><span class="pre">session</span></span><a class="headerlink" href="#O365.excel.TableColumn.session" title="Link to this definition"></a></dt>
<dd><p>session of the table column.. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> session</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.TableColumn.table">
<span class="sig-name descname"><span class="pre">table</span></span><a class="headerlink" href="#O365.excel.TableColumn.table" title="Link to this definition"></a></dt>
<dd><p>Parent of the table column. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> parent</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableColumn.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableColumn.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableColumn.update" title="Link to this definition"></a></dt>
<dd><p>Updates this column
:param values: values to update</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.TableColumn.values">
<span class="sig-name descname"><span class="pre">values</span></span><a class="headerlink" href="#O365.excel.TableColumn.values" title="Link to this definition"></a></dt>
<dd><p>Represents the raw values of the specified range.
The data returned could be of type string, number, or a Boolean.
Cell that contain an error will return the error string. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> list[list]</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.excel.TableRow">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.excel.</span></span><span class="sig-name descname"><span class="pre">TableRow</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableRow"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableRow" title="Link to this definition"></a></dt>
<dd><p>An Excel Table Row</p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableRow.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableRow.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableRow.__init__" title="Link to this definition"></a></dt>
<dd><p>Object initialization</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – A protocol class or instance to be used with
this connection</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – main_resource to be used in these API
communications</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableRow.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableRow.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableRow.delete" title="Link to this definition"></a></dt>
<dd><p>Deletes this row</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableRow.get_range">
<span class="sig-name descname"><span class="pre">get_range</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableRow.get_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableRow.get_range" title="Link to this definition"></a></dt>
<dd><p>Gets the range object associated with the entire row</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.TableRow.index">
<span class="sig-name descname"><span class="pre">index</span></span><a class="headerlink" href="#O365.excel.TableRow.index" title="Link to this definition"></a></dt>
<dd><p>The index of the row within the rows collection of the table. Zero-based.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.TableRow.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.excel.TableRow.object_id" title="Link to this definition"></a></dt>
<dd><p>Id of the Table Row <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.TableRow.session">
<span class="sig-name descname"><span class="pre">session</span></span><a class="headerlink" href="#O365.excel.TableRow.session" title="Link to this definition"></a></dt>
<dd><p>Session of table row <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> session</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.TableRow.table">
<span class="sig-name descname"><span class="pre">table</span></span><a class="headerlink" href="#O365.excel.TableRow.table" title="Link to this definition"></a></dt>
<dd><p>Parent of the table row. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> parent</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.TableRow.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#TableRow.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.TableRow.update" title="Link to this definition"></a></dt>
<dd><p>Updates this row</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.TableRow.values">
<span class="sig-name descname"><span class="pre">values</span></span><a class="headerlink" href="#O365.excel.TableRow.values" title="Link to this definition"></a></dt>
<dd><p>The raw values of the specified range.
The data returned could be of type string, number, or a Boolean.
Any cell that contain an error will return the error string.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> list[list]</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.excel.WorkBook">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.excel.</span></span><span class="sig-name descname"><span class="pre">WorkBook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_item</span></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persist</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook" title="Link to this definition"></a></dt>
<dd><dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkBook.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_item</span></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persist</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook.__init__" title="Link to this definition"></a></dt>
<dd><p>Create a workbook representation</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file_item</strong> (<a class="reference internal" href="onedrive.html#O365.drive.File" title="O365.drive.File"><em>File</em></a>) – the Drive File you want to interact with</p></li>
<li><p><strong>use_session</strong> (<em>Bool</em>) – Whether or not to use a session to be more efficient</p></li>
<li><p><strong>persist</strong> (<em>Bool</em>) – Whether or not to persist this info</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkBook.add_named_range">
<span class="sig-name descname"><span class="pre">add_named_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reference</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_formula</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook.add_named_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook.add_named_range" title="Link to this definition"></a></dt>
<dd><p>Adds a new name to the collection of the given scope using the user’s locale for the formula
:param str name: the name of this range
:param str reference: the reference for this range or formula
:param str comment: a comment to describe this named range
:param bool is_formula: True if the reference is a formula
:return: NamedRange instance</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkBook.add_worksheet">
<span class="sig-name descname"><span class="pre">add_worksheet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook.add_worksheet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook.add_worksheet" title="Link to this definition"></a></dt>
<dd><p>Adds a new worksheet</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkBook.delete_worksheet">
<span class="sig-name descname"><span class="pre">delete_worksheet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">worksheet_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook.delete_worksheet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook.delete_worksheet" title="Link to this definition"></a></dt>
<dd><p>Deletes a worksheet by it’s id</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkBook.get_named_range">
<span class="sig-name descname"><span class="pre">get_named_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook.get_named_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook.get_named_range" title="Link to this definition"></a></dt>
<dd><p>Retrieves a Named range by it’s name</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkBook.get_named_ranges">
<span class="sig-name descname"><span class="pre">get_named_ranges</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook.get_named_ranges"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook.get_named_ranges" title="Link to this definition"></a></dt>
<dd><p>Returns the list of named ranges for this Workbook</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkBook.get_table">
<span class="sig-name descname"><span class="pre">get_table</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id_or_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook.get_table"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook.get_table" title="Link to this definition"></a></dt>
<dd><p>Retrieves a Table by id or name
:param str id_or_name: The id or name of the column
:return: a Table instance</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkBook.get_tables">
<span class="sig-name descname"><span class="pre">get_tables</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook.get_tables"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook.get_tables" title="Link to this definition"></a></dt>
<dd><p>Returns a collection of this workbook tables</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkBook.get_workbookapplication">
<span class="sig-name descname"><span class="pre">get_workbookapplication</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook.get_workbookapplication"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook.get_workbookapplication" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkBook.get_worksheet">
<span class="sig-name descname"><span class="pre">get_worksheet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id_or_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook.get_worksheet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook.get_worksheet" title="Link to this definition"></a></dt>
<dd><p>Gets a specific worksheet by id or name</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkBook.get_worksheets">
<span class="sig-name descname"><span class="pre">get_worksheets</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook.get_worksheets"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook.get_worksheets" title="Link to this definition"></a></dt>
<dd><p>Returns a collection of this workbook worksheets</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkBook.invoke_function">
<span class="sig-name descname"><span class="pre">invoke_function</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function_name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">function_params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkBook.invoke_function"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkBook.invoke_function" title="Link to this definition"></a></dt>
<dd><p>Invokes an Excel Function</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkBook.name">
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#O365.excel.WorkBook.name" title="Link to this definition"></a></dt>
<dd><p>The name of the workbook. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:**str</strong></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkBook.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.excel.WorkBook.object_id" title="Link to this definition"></a></dt>
<dd><p>The id of the workbook. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str**</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkBook.session">
<span class="sig-name descname"><span class="pre">session</span></span><a class="headerlink" href="#O365.excel.WorkBook.session" title="Link to this definition"></a></dt>
<dd><p>The session for the workbook. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> WorkbookSession</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.excel.WorkSheet">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.excel.</span></span><span class="sig-name descname"><span class="pre">WorkSheet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet" title="Link to this definition"></a></dt>
<dd><p>An Excel WorkSheet</p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.__init__" title="Link to this definition"></a></dt>
<dd><p>Object initialization</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – A protocol class or instance to be used with
this connection</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – main_resource to be used in these API
communications</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.add_named_range">
<span class="sig-name descname"><span class="pre">add_named_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reference</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_formula</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.add_named_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.add_named_range" title="Link to this definition"></a></dt>
<dd><p>Adds a new name to the collection of the given scope using the user’s locale for the formula
:param str name: the name of this range
:param str reference: the reference for this range or formula
:param str comment: a comment to describe this named range
:param bool is_formula: True if the reference is a formula
:return: NamedRange instance</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.add_table">
<span class="sig-name descname"><span class="pre">add_table</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">has_headers</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.add_table"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.add_table" title="Link to this definition"></a></dt>
<dd><p>Adds a table to this worksheet
:param str address: a range address eg: ‘A1:D4’
:param bool has_headers: if the range address includes headers or not
:return: a Table instance</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.append_rows">
<span class="sig-name descname"><span class="pre">append_rows</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rows</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.append_rows"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.append_rows" title="Link to this definition"></a></dt>
<dd><p>Appends rows to the end of a worksheet. There is no direct Graph API to do this operation without a Table
instance. Instead, this method identifies the last row in the worksheet and requests a range after that row
and updates that range.</p>
<p>Beware! If you open your workbook from sharepoint and delete all of the rows in one go and attempt to append
new rows, you will get undefined behavior from the Microsoft Graph API. I don’t know if I did not give enough
time for the backend to synchronize from the moment of deletion on my browser and the moment I triggered my
script, but this is something I have observed. Sometimes insertion fails and sometimes it inserts where the new
row would have been if data had not been deleted from the browser side. Maybe it is an API cache issue. However,
after the first row is inserted successfully, this undefined behavior goes away on repeat calls to my scripts.
Documenting this behavior for future consumers of this API.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>rows</strong> (<em>list</em><em>[</em><em>list</em><em>[</em><em>str</em><em>]</em><em>]</em>) – list of rows to push to this range. If updating a single cell, pass a list
containing a single row (list) containing a single cell worth of data.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.delete" title="Link to this definition"></a></dt>
<dd><p>Deletes this worksheet</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.get_cell">
<span class="sig-name descname"><span class="pre">get_cell</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">row</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">column</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.get_cell"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.get_cell" title="Link to this definition"></a></dt>
<dd><p>Gets the range object containing the single cell based on row and column numbers.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.get_named_range">
<span class="sig-name descname"><span class="pre">get_named_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.get_named_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.get_named_range" title="Link to this definition"></a></dt>
<dd><p>Retrieves a Named range by it’s name</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.get_range">
<span class="sig-name descname"><span class="pre">get_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.get_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.get_range" title="Link to this definition"></a></dt>
<dd><p>Returns a Range instance from whitin this worksheet
:param str address: Optional, the range address you want
:return: a Range instance</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.get_table">
<span class="sig-name descname"><span class="pre">get_table</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id_or_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.get_table"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.get_table" title="Link to this definition"></a></dt>
<dd><p>Retrieves a Table by id or name
:param str id_or_name: The id or name of the column
:return: a Table instance</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.get_tables">
<span class="sig-name descname"><span class="pre">get_tables</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.get_tables"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.get_tables" title="Link to this definition"></a></dt>
<dd><p>Returns a collection of this worksheet tables</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.get_used_range">
<span class="sig-name descname"><span class="pre">get_used_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">only_values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.get_used_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.get_used_range" title="Link to this definition"></a></dt>
<dd><p>Returns the smallest range that encompasses any cells that
have a value or formatting assigned to them.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>only_values</strong> (<em>bool</em>) – Optional. Defaults to True.
Considers only cells with values as used cells (ignores formatting).</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Range</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.name">
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#O365.excel.WorkSheet.name" title="Link to this definition"></a></dt>
<dd><p>The display name of the worksheet. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.excel.WorkSheet.object_id" title="Link to this definition"></a></dt>
<dd><p>The unique identifier for the worksheet in the workbook. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.position">
<span class="sig-name descname"><span class="pre">position</span></span><a class="headerlink" href="#O365.excel.WorkSheet.position" title="Link to this definition"></a></dt>
<dd><p>The zero-based position of the worksheet within the workbook. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.remove_sheet_name_from_address">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">remove_sheet_name_from_address</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.remove_sheet_name_from_address"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.remove_sheet_name_from_address" title="Link to this definition"></a></dt>
<dd><p>Removes the sheet name from a given address</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.session">
<span class="sig-name descname"><span class="pre">session</span></span><a class="headerlink" href="#O365.excel.WorkSheet.session" title="Link to this definition"></a></dt>
<dd><p>Thesession of the worksheet. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> session</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">position</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visibility</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.update" title="Link to this definition"></a></dt>
<dd><p>Changes the name, position or visibility of this worksheet</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.update_cells">
<span class="sig-name descname"><span class="pre">update_cells</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rows</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkSheet.update_cells"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkSheet.update_cells" title="Link to this definition"></a></dt>
<dd><p>Updates the cells at a given range in this worksheet. This is a convenience method since there is no
direct endpoint API for tableless row updates.
:param str|Range address: the address to resolve to a range which can be used for updating cells.
:param list[list[str]] rows: list of rows to push to this range. If updating a single cell, pass a list
containing a single row (list) containing a single cell worth of data.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.visibility">
<span class="sig-name descname"><span class="pre">visibility</span></span><a class="headerlink" href="#O365.excel.WorkSheet.visibility" title="Link to this definition"></a></dt>
<dd><p>The visibility of the worksheet.
The possible values are: Visible, Hidden, VeryHidden. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkSheet.workbook">
<span class="sig-name descname"><span class="pre">workbook</span></span><a class="headerlink" href="#O365.excel.WorkSheet.workbook" title="Link to this definition"></a></dt>
<dd><p>The parent of the worksheet. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> parent</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.excel.WorkbookApplication">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.excel.</span></span><span class="sig-name descname"><span class="pre">WorkbookApplication</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">workbook</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookApplication"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookApplication" title="Link to this definition"></a></dt>
<dd><dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookApplication.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">workbook</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookApplication.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookApplication.__init__" title="Link to this definition"></a></dt>
<dd><p>Create A WorkbookApplication representation</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>workbook</strong> – A workbook object, of the workboook that you want to interact with</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookApplication.get_details">
<span class="sig-name descname"><span class="pre">get_details</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookApplication.get_details"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookApplication.get_details" title="Link to this definition"></a></dt>
<dd><p>Gets workbookApplication</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkbookApplication.parent">
<span class="sig-name descname"><span class="pre">parent</span></span><a class="headerlink" href="#O365.excel.WorkbookApplication.parent" title="Link to this definition"></a></dt>
<dd><p>The application parent. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> Workbook</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookApplication.run_calculations">
<span class="sig-name descname"><span class="pre">run_calculations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">calculation_type</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookApplication.run_calculations"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookApplication.run_calculations" title="Link to this definition"></a></dt>
<dd><p>Recalculate all currently opened workbooks in Excel.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.excel.</span></span><span class="sig-name descname"><span class="pre">WorkbookSession</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persist</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookSession"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookSession" title="Link to this definition"></a></dt>
<dd><p>See <a class="reference external" href="https://docs.microsoft.com/en-us/graph/api/resources/excel?view=graph-rest-1.0#sessions-and-persistence">https://docs.microsoft.com/en-us/graph/api/resources/excel?view=graph-rest-1.0#sessions-and-persistence</a></p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persist</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookSession.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookSession.__init__" title="Link to this definition"></a></dt>
<dd><p>Create a workbook session object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parent</strong> – parent for this operation</p></li>
<li><p><strong>con</strong> (<a class="reference internal" href="connection.html#O365.connection.Connection" title="O365.connection.Connection"><em>Connection</em></a>) – connection to use if no parent specified</p></li>
<li><p><strong>persist</strong> (<em>Bool</em>) – Whether or not to persist the session changes</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.close_session">
<span class="sig-name descname"><span class="pre">close_session</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookSession.close_session"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookSession.close_session" title="Link to this definition"></a></dt>
<dd><p>Close the current session</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.create_session">
<span class="sig-name descname"><span class="pre">create_session</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookSession.create_session"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookSession.create_session" title="Link to this definition"></a></dt>
<dd><p>Request a new session id</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookSession.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookSession.delete" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookSession.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookSession.get" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.inactivity_limit">
<span class="sig-name descname"><span class="pre">inactivity_limit</span></span><a class="headerlink" href="#O365.excel.WorkbookSession.inactivity_limit" title="Link to this definition"></a></dt>
<dd><p>The inactivity limit. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> timedelta</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.last_activity">
<span class="sig-name descname"><span class="pre">last_activity</span></span><a class="headerlink" href="#O365.excel.WorkbookSession.last_activity" title="Link to this definition"></a></dt>
<dd><p>The time of last activity. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> datetime</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.patch">
<span class="sig-name descname"><span class="pre">patch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookSession.patch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookSession.patch" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.persist">
<span class="sig-name descname"><span class="pre">persist</span></span><a class="headerlink" href="#O365.excel.WorkbookSession.persist" title="Link to this definition"></a></dt>
<dd><p>Whether or not the session changes are persisted. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> bool</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.post">
<span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookSession.post"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookSession.post" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.prepare_request">
<span class="sig-name descname"><span class="pre">prepare_request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookSession.prepare_request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookSession.prepare_request" title="Link to this definition"></a></dt>
<dd><p>If session is in use, prepares the request headers and
checks if the session is expired.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.put">
<span class="sig-name descname"><span class="pre">put</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookSession.put"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookSession.put" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.refresh_session">
<span class="sig-name descname"><span class="pre">refresh_session</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/excel.html#WorkbookSession.refresh_session"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.excel.WorkbookSession.refresh_session" title="Link to this definition"></a></dt>
<dd><p>Refresh the current session id</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.excel.WorkbookSession.session_id">
<span class="sig-name descname"><span class="pre">session_id</span></span><a class="headerlink" href="#O365.excel.WorkbookSession.session_id" title="Link to this definition"></a></dt>
<dd><p>The session id. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

</dd></dl>

</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="directory.html" class="btn btn-neutral float-left" title="Directory" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="group.html" class="btn btn-neutral float-right" title="Group" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2025, alejcas.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>